package com.alon.spring01.common.swagger2;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @program: spring01
 * @description: swagger配置
 * @author: yulongguang
 * @create: 2019-04-13 17:52
 **/
@Configuration
@EnableSwagger2
public class Swagger2Config {
    //swagger2的配置文件，这里可以配置swagger的一些基本的内容，比如扫描的包等等
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                        .apiInfo(apiInfo())
                        .select()
                        //为当前包路径
                        .apis(RequestHandlerSelectors.basePackage("com.alon.spring01.controller"))
                        .paths(PathSelectors.any())
                        .build();
    }

    //构建api 文档的详细信息函数，注意这里的注解引用的是哪个
    private ApiInfo apiInfo(){
        //页面标题
        return new ApiInfoBuilder().title("Spring Boot 测试 Swagger2 构建RESTful API")
                //创建人
                .contact(new Contact("阿龙","",""))
                //版本号
                .version("2.0")
                //描述
                .description("API 描述")
                .build();
    }
}
